Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds new documentation files for the analytical solution of the 1D heat equation solver. The most significant changes are the inclusion of Doxygen-generated HTML and JavaScript files related to the analytical method, as well as a new LaTeX file for formulas in dark mode.
Documentation additions for analytical solution:
docs/html/analytical_8cpp_source 2.html, providing the full source code documentation forsrc/methods/analytical.cpp, including detailed descriptions of theAnalytical::solveandAnalytical::get_profilemethods.docs/html/analytical_8hpp 2.html, documenting the header fileinclude/methods/analytical.hppand theAnalyticalclass for the analytical solution.docs/html/analytical_8hpp 2.js, a JavaScript file supporting the Doxygen documentation for theAnalyticalclass.Formula and visualization support:
docs/html/_formulas_dark 2.tex, a LaTeX file with formulas and math expressions for the heat equation, formatted for dark mode display.